/*
 * Copyright 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.appactions.interaction.capabilities.testing

import androidx.annotation.RestrictTo
import androidx.annotation.VisibleForTesting
import androidx.appactions.interaction.proto.FulfillmentRequest

/**
 * Represents a request which can be sent to some capability session for unit testing.
 */
@VisibleForTesting
class CapabilityRequest @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
constructor(
  @get:RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
  val fulfillmentRequest: FulfillmentRequest
) {
  /**
   * Returns a new CapabilityRequest that sets an identifier to the first Fulfillment in this
   * request.
   * Fulfillments after the first are dropped.
   */
  @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
  fun addCapabilityIdentifier(capabilityIdentifier: String): CapabilityRequest {
    val fulfillment = fulfillmentRequest.getFulfillments(0)
    return CapabilityRequest(
      FulfillmentRequest.newBuilder().addFulfillments(
        fulfillment.toBuilder().setIdentifier(capabilityIdentifier).build()
      ).build()
    )
  }
}
